release: v0.3.4 — test coverage & documentation for awesome-go#5
Merged
release: v0.3.4 — test coverage & documentation for awesome-go#5
Conversation
- Total coverage: 90.1% -> 93.8% (+3.7%) - Binding: 64.4% -> 97.7% (+33.3%) - Core: 93.1% -> 94.3%, Middleware: 91.7% -> 95.6% - New tests for all 0% coverage public API functions - Updated README.md and CHANGELOG.md with current metrics
- JWT: JWT() takes signingKey, not config; use JWTWithConfig for config - RateLimit: RateLimit() takes (float64, int), not config struct - CircuitBreaker: CircuitBreaker() takes no args; show helper functions - Remove non-existent router.Run(), use http.ListenAndServe - Fix godoc: *fursy.Box -> *fursy.Context in package comments - Update coverage numbers to 93.8% in README
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Remove push triggers for feature/release/hotfix/develop branches - Keep only push:main + pull_request:main - PRs run tests once (not twice)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepare fursy for awesome-go submission: improved test coverage, fixed documentation, updated release files.
Test Coverage (93.8%, up from 91.7%)
internal/binding: 64.4% -> 97.7% (allsetFieldtypes, edge cases, invalid inputs)box_test.go: AddedUnauthorizedandForbiddentestsrouter_generic_test.go: New file - tests forHEAD[Req,Res]()andOPTIONS[Req,Res]()openapi_test.go:WriteJSONandWriteYAMLtestsmiddleware/circuitbreaker_test.go: 6 new tests (constructors, state, counts, reset)middleware/logger_test.go,recovery_test.go: Default constructor testsDocumentation Fixes (5 critical API mismatches)
JWT()signature: config struct ->JWT(signingKey)/JWTWithConfig(config)RateLimit()signature: config struct ->RateLimit(rate, burst)/RateLimitWithConfig(config)CircuitBreaker()signature: removed non-existent fields, added helper functionsrouter.Run()->http.ListenAndServe()(Run method does not exist)*fursy.Boxwithout type params ->*fursy.ContextRelease Files
Test plan
go test ./...- all tests passgolangci-lint run- 0 issues